CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /projects/{projectId}/points:read (Post)
Post/projects/{projectId}/points:read
Description
Gets an array of point objects that satisfy the filter criteria specified in the request body.
Parameters
NameDescriptionData Type
the id of the projectstring
Request (application/json)

The request body is of type object.

Overview

Filters : Filters
HasAlarm : boolean
filters the list of points based on the presence of alarm configuration
PointID : string
provides a wild card string to filter points by their PointID.
DeviceID : string
Device ID for the point, where the point data originates. If the point is a global point, the device is "$GLOBAL". If the point is an equation point, the device is $DERIVED.
ResourceID : string
provides a wild card string to filter points by their ResourceID.
PointTypeID : string
Point Type ID of the point (UINT, REAL, etc.)
Description : string
provides a wild card string to filter points by their Description.
AccessFilter : string
The value for this filter is set to 'E' or 'e', while character * can be used. When specified will return enterpirse points.
MaxItems : integer
200 Response

The response body is of type ServerSettings.

results from the call

Overview

ServerSettings
The results of the Settings Get.
MaxReadRequestObjects : number
The maximum number of objects that can be read in one call.
MaxWriteRequestObjects : number
The maximum number of objects that can be written in one call.
Fault Responses
FaultDescription
This fault returns a response body of type ProblemDetails.
General error
Remarks
Returns JSON containing an array of point objects
See Also